Added Fastapi Lifespan to docs #589
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarify usage of TaskiqDepends with FastAPI dependencies and update code examples.
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request updates the FastAPI integration documentation to recommend the modern lifespan context manager approach for managing broker startup and shutdown, while retaining the older on_event method marked as deprecated.
Changes:
- Added a new documentation section showing how to use FastAPI's
lifespanevent withasynccontextmanagerfor broker lifecycle management - Organized both the recommended
lifespanapproach and the deprecatedon_eventapproach into a tabbed interface for easy comparison
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the documentation for integrating Taskiq with FastAPI, focusing on how to properly manage broker startup and shutdown. The main improvement is the addition of a recommended approach using FastAPI's
lifespanevent, while also marking the olderon_eventmethod as deprecated.Broker lifecycle management documentation:
lifespanevent for broker startup and shutdown, ensuring proper resource management.on_eventapproach as deprecated and organized both methods into a tabbed interface for clarity. [1] [2]